Release 10.1A: OpenEdge Reporting:
Query/Results Administration and Development

Preface

This Preface contains the following sections:

Purpose
Audience
Organization
Using this manual
Typographical conventions
Examples of syntax descriptions
OpenEdge messages

Purpose

This guide introduces you to the administration and development capabilities of Progress Results® Version 2 for Windows. Query/Results, more commonly referenced throughout this guide as Results, is an interactive, menu-driven software tool that lets you query, report, and maintain information contained in Progress-supported databases.

Audience

This book is a guide for both Results programmers and site administrators. A Results programmer is a Progress programmer who wants to customize and extend Results. A site administrator is a system administrator at an end user site who has the responsibility of maintaining and configuring Results for end-users. This manual requires that both audiences know and understand the end-user features and functionality of Results. For a basic understanding of the Results Version 2 product, see the OpenEdge Reporting: Query/Results for Windows or OpenEdge Reporting: Query/Results for UNIX .

Organization

Chapter 1 "Results for Administrators and Programmers"

Provides an overview of administration and development tasks in Results and describes how to start and stop Results.

Chapter 2 "Administering Results"

Describes the system administration tools and procedures to use for a deployed Results application at an end-user site.

Chapter 3 "Programming Results"

Describes the concepts, tools, and programming techniques required to customize and extend Results.

Chapter 4 "Deploying Results Applications"

Explains how to deploy a Results application to an end-user environment.

Appendix A, "Results Features"

Contains an alphabetical listing of reference entries for each feature in Results.

Appendix B, "Results Limits"

Lists the limits that exist within Results.

Appendix C, "Results Files"

Provides information about files that Results generates and file formats.

Using this manual

You need not read through the whole manual in detail. A good strategy would be to skim the whole manual once, and then re-read in detail as needed.

Also, due to the differences between the programming and administration audiences, not all portions of this manual are appropriate for both audiences. The following table suggests a reading path for each audience:

To learn this inforamtion...	Read this material:
How to set up and maintain Results.	Chapter 1 "Results for Administrators and Programmers"and Chapter 2, "Administering Results," Appendix A, "Results Features" and Appendix C, "Results Files"
How to develop and deploy a Results application.	All chapters and appendices.

Typographical conventions

This manual uses the following typographical conventions:

Convention	Description
Bold	Bold typeface indicates commands or characters the user types, or the names of user interface elements.
Italic	Italic typeface indicates the title of a document, provides emphasis, or signifies new terms.
SMALL, BOLD CAPITAL LETTERS	Small, bold capital letters indicate OpenEdge™ key functions and generic keyboard keys; for example, GET and CTRL.
KEY1-KEY2	A hyphen between key names indicates a simultaneous key sequence: you press and hold down the first key while pressing the second key. For example, CTRL-X.
KEY1 KEY2	A space between key names indicates a sequential key sequence: you press and release the first key, then press another key. For example, ESCAPE H.
Syntax:
Fixed width	A fixed-width font is used in syntax statements. code examples, and for system output and filenames.
Fixed-width italics	Fixed-width italics indicate variables in syntax statements.
Fixed-width bold	Fixed-width bold indicates variables with special emphasis.
UPPERCASE fixed width	Uppercase words are Progress® 4GL language keywords. Although these always are shown in uppercase, you can type them in either uppercase or lowercase in a procedure.
Period (.) or colon (:)	All statements except DO, FOR, FUNCTION, PROCEDURE, and REPEAT end with a period. DO, FOR, FUNCTION, PROCEDURE, and REPEAT statements can end with either a period or a colon.
[ ]	Large brackets indicate the items within them are optional.
[ ]	Small brackets are part of the Progress 4GL language.
{ }	Large braces indicate the items within them are required. They are used to simplify complex syntax diagrams.
{ }	Small braces are part of the Progress 4GL language. For example, a called external procedure must use braces when referencing arguments passed by a calling procedure.
|	A vertical bar indicates a choice.
...	Ellipses indicate repetition: you can choose one or more of the preceding items.

Examples of syntax descriptions

In this example, ACCUM is a keyword, and aggregate and expression are variables:

ACCUM aggregate expression

FOR is one of the statements that can end with either a period or a colon, as in this example:

FOR EACH Customer:   DISPLAY Name. END.

In this example, STREAM stream, UNLESS-HIDDEN, and NO-ERROR are optional:

DISPLAY [ STREAM stream ] [ UNLESS-HIDDEN ] [ NO-ERROR ]

In this example, the outer (small) brackets are part of the language, and the inner (large) brackets denote an optional item:

INITIAL [ constant [ , constant ] ]

A called external procedure must use braces when referencing compile-time arguments passed by a calling procedure, as shown in this example:

{ &argument-name }

In this example, EACH, FIRST, and LAST are optional, but you can choose only one of them:

PRESELECT [ EACH | FIRST | LAST ] record-phrase

In this example, you must include two expressions, and optionally you can include more. Multiple expressions are separated by commas:

MAXIMUM ( expression , expression [ , expression ] ... )

In this example, you must specify MESSAGE and at least one expression or SKIP [ (n) ], and any number of additional expression or SKIP [ ( n ) ] is allowed:

MESSAGE { expression | SKIP [ ( n ) ] } ...

In this example, you must specify {include-file, then optionally any number of argument or &argument-name = "argument-value", and then terminate with }:

{ include-file [ argument | &argument-name = "argument-value" ] ... }

Long syntax descriptions split across lines

Some syntax descriptions are too long to fit on one line. When syntax descriptions are split across multiple lines, groups of optional and groups of required items are kept together in the required order.

In this example, WITH is followed by six optional items:

Syntax

WITH [ ACCUM max-length ] [ expression DOWN ] [ CENTERED ] [ n COLUMNS ] [ SIDE-LABELS ] [ STREAM-IO ]

Complex syntax descriptions with both required and optional elements

Some syntax descriptions are too complex to distinguish required and optional elements by bracketing only the optional elements. For such syntax, the descriptions include both braces (for required elements) and brackets (for optional elements).

In this example, ASSIGN requires either one or more field entries or one record. Options available with field or record are grouped with braces and brackets:

Syntax

ASSIGN { { [ FRAME frame ] { field [ = expression ] } [ WHEN expression ] } ... | { record [ EXCEPT field ... ] } }

OpenEdge messages

OpenEdge displays several types of messages to inform you of routine and unusual occurrences:

Execution messages inform you of errors encountered while OpenEdge is running a procedure; for example, if OpenEdge cannot find a record with a specified index field value.
Compile messages inform you of errors found while OpenEdge is reading and analyzing a procedure before running it; for example, if a procedure references a table name that is not defined in the database.
Startup messages inform you of unusual conditions detected while OpenEdge is getting ready to execute; for example, if you entered an invalid startup parameter.

After displaying a message, OpenEdge proceeds in one of several ways:

Continues execution, subject to the error-processing actions that you specify or that are assumed as part of the procedure. This is the most common action taken after execution messages.
Returns to the Progress Procedure Editor, so you can correct an error in a procedure. This is the usual action taken after compiler messages.
Halts processing of a procedure and returns immediately to the Progress Procedure Editor. This does not happen often.
Terminates the current session.

OpenEdge messages end with a message number in parentheses. In this example, the message number is 200:

** Unknown table name table. (200)

If you encounter an error that terminates OpenEdge, note the message number before restarting.

Obtaining more information about OpenEdge messages

On Windows platforms, use OpenEdge online help to obtain more information about OpenEdge messages. Many OpenEdge tools include the following Help menu options to provide information about messages:

Choose Help Recent Messages to display detailed descriptions of the most recent OpenEdge message and all other messages returned in the current session.
Choose Help Messages and then enter the message number to display a description of a specific OpenEdge message.
In the Progress Procedure Editor, press the HELP key or F1.

On UNIX platforms, use the Progress PRO command to start a single-user mode character OpenEdge client session and view a brief description of a message by providing its number.

To use the PRO command to obtain a message description by message number:

Start the Progress Procedure Editor:

install-dir/dlc/bin/pro

Press F3 to access the menu bar, then choose Help Messages.
Type the message number and press ENTER. Details about that message number appear.
Press F4 to close the message, press F3 to access the Progress Procedure Editor menu, and choose File Exit.